Детальная информация о клиенте

Запрос позволяет получить подробную информацию о клиенте.

Синтаксис запроса

GET https://business.taxi.yandex.ru/api/1.0/client/{идентификатор клиента}

🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.

Заголовки запроса:

Authorization

OAuth-токен. Процесс получения токена описан в разделе Начало работы.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле Описание Формат
comment Комментарий о клиенте. Строка
yandex_login Имя учетной записи на Яндексе. Строка
cost_centers_file_name Является устаревшим. Название файла кост-центров. Строка
contract_id Является устаревшим. Идентификационный номер контракта клиента. Строка
billing_name Название клиента для биллинга. Строка
is_active Является устаревшим. Признак активности клиента. Неактивный клиент не имеет возможности заказывать поездки. Логическое
cabinet_only_role_id Идентификатор роли пользователей без права самостоятельного заказа. Строка
_id Идентификационный номер клиента. Строка
email Адрес электронной почты клиента. Строка
name Название клиента. Строка

Пример запроса

GET https://business.taxi.yandex.ru/api/1.0/client/a2...d09
...
Authorization: <OAuth-токен>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "comment": "",
  "yandex_login": "example-company",
  "cost_centers_file_name": "CC.xls",
  "contract_id": "49975/16",
  "billing_name": "ExampleCompany",
  "is_active": true,
  "cabinet_only_role_id": "1e0202a78f894ad38127aecf31140fbd",
  "_id": "a2...d09",
  "email": "example-mail@example-company.ru",
  "name": "Тестовая Компания"
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 401 — был передан неверный OAuth-токен.
  • 400 — в запросе был передан неизвестный параметр.
  • 403 — у клиента не хватает прав на выполнение данного запроса.
Предыдущая
Список тарифов
Следующая
Создание кост-центров клиента